<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: ipc::transport::struc::shm::Reader&lt; Shm_arena &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceipc.html">ipc</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1transport.html">transport</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1transport_1_1struc.html">struc</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1transport_1_1struc_1_1shm.html">shm</a></li><li class="navelem"><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html">Reader</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-types">Private Types</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#related">Related Functions</a> &#124;
<a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">ipc::transport::struc::shm::Reader&lt; Shm_arena &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Implements <a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__reader.html" title="A documentation-only concept that is, conceptually, roughly what capnp::MessageReader is to capnp::Me...">Struct_reader</a> concept by interpreting a serialization by <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html" title="Implements Struct_builder concept with maximal zero-copy perf by (1) storing the actual user-schema-c...">shm::Builder</a> with the same template params.  
 <a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html">serializer.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ipc::transport::struc::shm::Reader&lt; Shm_arena &gt;:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classipc_1_1transport_1_1struc_1_1shm_1_1Reader__inherit__graph.svg" width="310" height="119"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ipc::transport::struc::shm::Reader&lt; Shm_arena &gt;:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classipc_1_1transport_1_1struc_1_1shm_1_1Reader__coll__graph.svg" width="1135" height="396"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1transport_1_1struc_1_1shm_1_1Reader_1_1Config.html">Config</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements <a class="el" href="structipc_1_1transport_1_1struc_1_1Struct__reader_1_1Config.html" title="Analogous to Struct_builder::Config but for deserialization.">Struct_reader::Config</a> sub-concept.  <a href="structipc_1_1transport_1_1struc_1_1shm_1_1Reader_1_1Config.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a42c8e0c8210121f3969aeb019df5c5b3"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a42c8e0c8210121f3969aeb019df5c5b3">Arena</a> = Shm_arena</td></tr>
<tr class="memdesc:a42c8e0c8210121f3969aeb019df5c5b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Short-hand for <code>Shm_arena</code> template param.  <a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a42c8e0c8210121f3969aeb019df5c5b3">More...</a><br /></td></tr>
<tr class="separator:a42c8e0c8210121f3969aeb019df5c5b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae77502abf0b04ad7543266fc6c34f49d"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#ae77502abf0b04ad7543266fc6c34f49d">Session</a> = typename <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html">Builder</a>&lt; Shm_arena &gt;::Session</td></tr>
<tr class="memdesc:ae77502abf0b04ad7543266fc6c34f49d"><td class="mdescLeft">&#160;</td><td class="mdescRight">See <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a2d9808d9b0c04cf84c8e439b1643506d" title="Implements concept API.">shm::Builder::Session</a>.  <a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#ae77502abf0b04ad7543266fc6c34f49d">More...</a><br /></td></tr>
<tr class="separator:ae77502abf0b04ad7543266fc6c34f49d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a42d9fb1ff01d3acfc5adf01f16abadba"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a42d9fb1ff01d3acfc5adf01f16abadba">Reader</a> (const <a class="el" href="structipc_1_1transport_1_1struc_1_1shm_1_1Reader_1_1Config.html">Config</a> &amp;config)</td></tr>
<tr class="memdesc:a42d9fb1ff01d3acfc5adf01f16abadba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements concept API.  <a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a42d9fb1ff01d3acfc5adf01f16abadba">More...</a><br /></td></tr>
<tr class="separator:a42d9fb1ff01d3acfc5adf01f16abadba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37d334b7f819c2cf9b8d8ec07cb4ad09"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a37d334b7f819c2cf9b8d8ec07cb4ad09">~Reader</a> ()</td></tr>
<tr class="memdesc:a37d334b7f819c2cf9b8d8ec07cb4ad09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements concept API.  <a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a37d334b7f819c2cf9b8d8ec07cb4ad09">More...</a><br /></td></tr>
<tr class="separator:a37d334b7f819c2cf9b8d8ec07cb4ad09"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f57ff0e946af136ae3746d317008db5"><td class="memItemLeft" align="right" valign="top">flow::util::Blob *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a2f57ff0e946af136ae3746d317008db5">add_serialization_segment</a> (size_t max_sz)</td></tr>
<tr class="memdesc:a2f57ff0e946af136ae3746d317008db5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements concept API.  <a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a2f57ff0e946af136ae3746d317008db5">More...</a><br /></td></tr>
<tr class="separator:a2f57ff0e946af136ae3746d317008db5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aceb5816f4e9f312a8ce2ef17feb81223"><td class="memTemplParams" colspan="2">template&lt;typename Struct &gt; </td></tr>
<tr class="memitem:aceb5816f4e9f312a8ce2ef17feb81223"><td class="memTemplItemLeft" align="right" valign="top">Struct::Reader&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#aceb5816f4e9f312a8ce2ef17feb81223">deserialization</a> (<a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> *err_code=0)</td></tr>
<tr class="memdesc:aceb5816f4e9f312a8ce2ef17feb81223"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements concept API.  <a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#aceb5816f4e9f312a8ce2ef17feb81223">More...</a><br /></td></tr>
<tr class="separator:aceb5816f4e9f312a8ce2ef17feb81223"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-types" name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:a4bf6b31e4a5896d7ecc3236f1498602d"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a4bf6b31e4a5896d7ecc3236f1498602d">Capnp_heap_engine</a> = ::capnp::SegmentArrayMessageReader</td></tr>
<tr class="memdesc:a4bf6b31e4a5896d7ecc3236f1498602d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as in <a class="el" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html" title="Implements Struct_reader concept by straightforwardly interpreting a serialization by Heap_fixed_buil...">Heap_reader</a> but this time applied to SHM-stored segments in <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a57144d8e687161731d662b7d7b23fd0e" title="The outer SHM handle to the Segments_in_shm containing the serialization yielded by payload_msg_build...">m_btm_serialization_shm_handle</a>.  <a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a4bf6b31e4a5896d7ecc3236f1498602d">More...</a><br /></td></tr>
<tr class="separator:a4bf6b31e4a5896d7ecc3236f1498602d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4b859bec8f09d37cb041a8ee40c5007"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#ae4b859bec8f09d37cb041a8ee40c5007">Capnp_heap_engine_ptr</a> = boost::movelib::unique_ptr&lt; <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a4bf6b31e4a5896d7ecc3236f1498602d">Capnp_heap_engine</a> &gt;</td></tr>
<tr class="memdesc:ae4b859bec8f09d37cb041a8ee40c5007"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alias to pointer to <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a4bf6b31e4a5896d7ecc3236f1498602d" title="Same as in Heap_reader but this time applied to SHM-stored segments in m_btm_serialization_shm_handle...">Capnp_heap_engine</a>.  <a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#ae4b859bec8f09d37cb041a8ee40c5007">More...</a><br /></td></tr>
<tr class="separator:ae4b859bec8f09d37cb041a8ee40c5007"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c0a2d000e3994b7eeec3064112dcc5e"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a4c0a2d000e3994b7eeec3064112dcc5e">Segments_in_shm</a> = typename <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Capnp__message__builder.html">Capnp_message_builder</a>&lt; <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a42c8e0c8210121f3969aeb019df5c5b3">Arena</a> &gt;::Segments_in_shm_borrowed</td></tr>
<tr class="memdesc:a4c0a2d000e3994b7eeec3064112dcc5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The data structure populated by <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html" title="Implements Struct_builder concept with maximal zero-copy perf by (1) storing the actual user-schema-c...">shm::Builder</a> counterpart.  <a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a4c0a2d000e3994b7eeec3064112dcc5e">More...</a><br /></td></tr>
<tr class="separator:a4c0a2d000e3994b7eeec3064112dcc5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67e07b2f8cdaff62e3f7223f4440826e"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a67e07b2f8cdaff62e3f7223f4440826e">Capnp_word_array_ptr</a> = kj::ArrayPtr&lt; const ::capnp::word &gt;</td></tr>
<tr class="memdesc:a67e07b2f8cdaff62e3f7223f4440826e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Similar to <a class="el" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#aea8a3f7dcb5c6f021bb19397b3b1705e" title="Alias to capnp type that&#39;s similar to boost::asio::const_buffer but stores word* and word count inste...">Heap_reader::Capnp_word_array_ptr</a>.  <a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a67e07b2f8cdaff62e3f7223f4440826e">More...</a><br /></td></tr>
<tr class="separator:a67e07b2f8cdaff62e3f7223f4440826e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:af9f19bfd2d275b3770a3c978ae451c31"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#ae77502abf0b04ad7543266fc6c34f49d">Session</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#af9f19bfd2d275b3770a3c978ae451c31">m_session</a></td></tr>
<tr class="memdesc:af9f19bfd2d275b3770a3c978ae451c31"><td class="mdescLeft">&#160;</td><td class="mdescRight">See class doc header and ctor doc header.  <a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#af9f19bfd2d275b3770a3c978ae451c31">More...</a><br /></td></tr>
<tr class="separator:af9f19bfd2d275b3770a3c978ae451c31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1edc9404d82d1fe78fd4a892d5dac22c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html">Heap_reader</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a1edc9404d82d1fe78fd4a892d5dac22c">m_top_engine</a></td></tr>
<tr class="memdesc:a1edc9404d82d1fe78fd4a892d5dac22c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The top-serialization reader, namely <a class="el" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html" title="Implements Struct_reader concept by straightforwardly interpreting a serialization by Heap_fixed_buil...">Heap_reader</a>, of our simple SHM-handle-bearing schema.  <a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a1edc9404d82d1fe78fd4a892d5dac22c">More...</a><br /></td></tr>
<tr class="separator:a1edc9404d82d1fe78fd4a892d5dac22c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea972cb0e04d447941d2080c2f2d3a98"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#ae4b859bec8f09d37cb041a8ee40c5007">Capnp_heap_engine_ptr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#aea972cb0e04d447941d2080c2f2d3a98">m_btm_engine</a></td></tr>
<tr class="memdesc:aea972cb0e04d447941d2080c2f2d3a98"><td class="mdescLeft">&#160;</td><td class="mdescRight">See <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a4bf6b31e4a5896d7ecc3236f1498602d" title="Same as in Heap_reader but this time applied to SHM-stored segments in m_btm_serialization_shm_handle...">Capnp_heap_engine</a>.  <a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#aea972cb0e04d447941d2080c2f2d3a98">More...</a><br /></td></tr>
<tr class="separator:aea972cb0e04d447941d2080c2f2d3a98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57144d8e687161731d662b7d7b23fd0e"><td class="memItemLeft" align="right" valign="top">Arena::template Handle&lt; <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a4c0a2d000e3994b7eeec3064112dcc5e">Segments_in_shm</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a57144d8e687161731d662b7d7b23fd0e">m_btm_serialization_shm_handle</a></td></tr>
<tr class="memdesc:a57144d8e687161731d662b7d7b23fd0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The outer SHM handle to the <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a4c0a2d000e3994b7eeec3064112dcc5e" title="The data structure populated by shm::Builder counterpart.">Segments_in_shm</a> containing the serialization yielded by payload_msg_builder().  <a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a57144d8e687161731d662b7d7b23fd0e">More...</a><br /></td></tr>
<tr class="separator:a57144d8e687161731d662b7d7b23fd0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36e431a3536848c99dd4f55a4d6b1453"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a67e07b2f8cdaff62e3f7223f4440826e">Capnp_word_array_ptr</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a36e431a3536848c99dd4f55a4d6b1453">m_btm_capnp_segments</a></td></tr>
<tr class="memdesc:a36e431a3536848c99dd4f55a4d6b1453"><td class="mdescLeft">&#160;</td><td class="mdescRight">Analogous to <a class="el" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#ae514982795db7d0301a7929d1006d30b" title="After deserialization(), capnp-targeted data structure which is essentially vector&lt;&gt; of each Blob::co...">Heap_reader::m_capnp_segments</a>; just points into SHM.  <a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a36e431a3536848c99dd4f55a4d6b1453">More...</a><br /></td></tr>
<tr class="separator:a36e431a3536848c99dd4f55a4d6b1453"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="related" name="related"></a>
Related Functions</h2></td></tr>
<tr><td class="ititle" colspan="2"><p >(Note that these are not member functions.) </p>
</td></tr>
<tr class="memitem:a6aed71b2ab83f2a087d66562ea2962b9"><td class="memTemplParams" colspan="2">template&lt;typename Shm_arena &gt; </td></tr>
<tr class="memitem:a6aed71b2ab83f2a087d66562ea2962b9"><td class="memTemplItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a6aed71b2ab83f2a087d66562ea2962b9">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html">Reader</a>&lt; Shm_arena &gt; &amp;val)</td></tr>
<tr class="memdesc:a6aed71b2ab83f2a087d66562ea2962b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints string representation of the given <code><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html" title="Implements Struct_reader concept by interpreting a serialization by shm::Builder with the same templa...">Reader</a></code> to the given <code>ostream</code>.  <a href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a6aed71b2ab83f2a087d66562ea2962b9">More...</a><br /></td></tr>
<tr class="separator:a6aed71b2ab83f2a087d66562ea2962b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;typename Shm_arena&gt;<br />
class ipc::transport::struc::shm::Reader&lt; Shm_arena &gt;</div><p >Implements <a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__reader.html" title="A documentation-only concept that is, conceptually, roughly what capnp::MessageReader is to capnp::Me...">Struct_reader</a> concept by interpreting a serialization by <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html" title="Implements Struct_builder concept with maximal zero-copy perf by (1) storing the actual user-schema-c...">shm::Builder</a> with the same template params. </p>
<p >If one understands how to use <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html" title="Implements Struct_builder concept with maximal zero-copy perf by (1) storing the actual user-schema-c...">shm::Builder</a> (see its doc header in-depth), it should be straightforward to figure out how to create/use a <code>*this</code>. Please read that; then come back here.</p>
<h3>How <code>Shm_arena</code> is used by a <code>*this</code></h3>
<p >It is a good question, as <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html" title="Implements Struct_reader concept by interpreting a serialization by shm::Builder with the same templa...">shm::Reader</a> is conceptually read-only w/r/t the SHM-stored serialization accessed by payload_msg_builder(). So why does it need any <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a42c8e0c8210121f3969aeb019df5c5b3" title="Short-hand for Shm_arena template param.">Arena</a>? Answer: well, it does not need <em>an</em> <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a42c8e0c8210121f3969aeb019df5c5b3" title="Short-hand for Shm_arena template param.">Arena</a>; unlike with <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html" title="Implements Struct_builder concept with maximal zero-copy perf by (1) storing the actual user-schema-c...">shm::Builder</a> you don't need to pass-in any <code>Arena*</code> into the ctor or elsewhere. That makes sense: it never allocates anything in SHM, only reads it. It does however need an equal <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a42c8e0c8210121f3969aeb019df5c5b3" title="Short-hand for Shm_arena template param.">Arena</a> template param. Why? Answer: There are internal reasons having to do with STL-compliant internal storage by the counterpart <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html" title="Implements Struct_builder concept with maximal zero-copy perf by (1) storing the actual user-schema-c...">shm::Builder</a>; to decode its data structures properly it needs to have some type information at compile-time; this "supplies" code &ndash; not data.</p>
<p >Anyway, just supply an equal <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a42c8e0c8210121f3969aeb019df5c5b3" title="Short-hand for Shm_arena template param.">Arena</a> template param. Should be fine.</p>
<h3>How <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#ae77502abf0b04ad7543266fc6c34f49d" title="See shm::Builder::Session.">shm::Reader::Session</a> (a/k/a <code>Shm_session</code>) is used by a <code>*this</code></h3>
<p ><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html" title="Implements Struct_builder concept with maximal zero-copy perf by (1) storing the actual user-schema-c...">shm::Builder</a>, internally, performs <code>Shm_arena::construct&lt;T&gt;()</code> to allocate a STL-compliant data structure and yield a <code>Shm_session</code>-lendable outer SHM handle. It performs <code>Shm_session::lend_object&lt;T&gt;()</code> in <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a7909a2d1e1d24037fb8af5338fffa783" title="Implements concept API.">shm::Builder::emit_serialization()</a>, registering the recipient-to-be process as the 2nd owner process. Then the counterpart <code>*this</code> performs <code>Shm_session::borrow_object&lt;T&gt;()</code> to recover the equivalent outer SHM handle to the same STL-compliant data structure the user had built up via <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#aaeceaccf183170b1785aa240921ae893" title="Implements concept API.">shm::Builder::payload_msg_builder()</a>.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html" title="Implements Struct_builder concept with maximal zero-copy perf by (1) storing the actual user-schema-c...">shm::Builder</a> The counterpart <a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__builder.html" title="A documentation-only concept defining the behavior of an object capable of zero-copy-serializing,...">Struct_builder</a> implementation that can create compatible serializations. </dd>
<dd>
<a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__reader.html" title="A documentation-only concept that is, conceptually, roughly what capnp::MessageReader is to capnp::Me...">Struct_reader</a>: implemented concept.</dd></dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">Shm_arena</td><td>Must be the same as the serializing <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html" title="Implements Struct_builder concept with maximal zero-copy perf by (1) storing the actual user-schema-c...">Builder</a> counterpart. Note that no object of this type is required to the ctor unlike with <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html" title="Implements Struct_builder concept with maximal zero-copy perf by (1) storing the actual user-schema-c...">Builder</a>. Only the type is necessary (see discussion above). </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00365">365</a> of file <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html">serializer.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a42c8e0c8210121f3969aeb019df5c5b3" name="a42c8e0c8210121f3969aeb019df5c5b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42c8e0c8210121f3969aeb019df5c5b3">&#9670;&nbsp;</a></span>Arena</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Shm_arena &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html">ipc::transport::struc::shm::Reader</a>&lt; Shm_arena &gt;::Arena =  Shm_arena</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Short-hand for <code>Shm_arena</code> template param. </p>

<p class="definition">Definition at line <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00373">373</a> of file <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html">serializer.hpp</a>.</p>

</div>
</div>
<a id="a4bf6b31e4a5896d7ecc3236f1498602d" name="a4bf6b31e4a5896d7ecc3236f1498602d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bf6b31e4a5896d7ecc3236f1498602d">&#9670;&nbsp;</a></span>Capnp_heap_engine</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Shm_arena &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html">ipc::transport::struc::shm::Reader</a>&lt; Shm_arena &gt;::Capnp_heap_engine =  ::capnp::SegmentArrayMessageReader</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Same as in <a class="el" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html" title="Implements Struct_reader concept by straightforwardly interpreting a serialization by Heap_fixed_buil...">Heap_reader</a> but this time applied to SHM-stored segments in <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a57144d8e687161731d662b7d7b23fd0e" title="The outer SHM handle to the Segments_in_shm containing the serialization yielded by payload_msg_build...">m_btm_serialization_shm_handle</a>. </p>

<p class="definition">Definition at line <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00463">463</a> of file <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html">serializer.hpp</a>.</p>

</div>
</div>
<a id="ae4b859bec8f09d37cb041a8ee40c5007" name="ae4b859bec8f09d37cb041a8ee40c5007"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4b859bec8f09d37cb041a8ee40c5007">&#9670;&nbsp;</a></span>Capnp_heap_engine_ptr</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Shm_arena &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html">ipc::transport::struc::shm::Reader</a>&lt; Shm_arena &gt;::Capnp_heap_engine_ptr =  boost::movelib::unique_ptr&lt;<a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a4bf6b31e4a5896d7ecc3236f1498602d">Capnp_heap_engine</a>&gt;</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Alias to pointer to <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a4bf6b31e4a5896d7ecc3236f1498602d" title="Same as in Heap_reader but this time applied to SHM-stored segments in m_btm_serialization_shm_handle...">Capnp_heap_engine</a>. </p>

<p class="definition">Definition at line <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00466">466</a> of file <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html">serializer.hpp</a>.</p>

</div>
</div>
<a id="a67e07b2f8cdaff62e3f7223f4440826e" name="a67e07b2f8cdaff62e3f7223f4440826e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67e07b2f8cdaff62e3f7223f4440826e">&#9670;&nbsp;</a></span>Capnp_word_array_ptr</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Shm_arena &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html">ipc::transport::struc::shm::Reader</a>&lt; Shm_arena &gt;::Capnp_word_array_ptr =  kj::ArrayPtr&lt;const ::capnp::word&gt;</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Similar to <a class="el" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#aea8a3f7dcb5c6f021bb19397b3b1705e" title="Alias to capnp type that&#39;s similar to boost::asio::const_buffer but stores word* and word count inste...">Heap_reader::Capnp_word_array_ptr</a>. </p>

<p class="definition">Definition at line <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00482">482</a> of file <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html">serializer.hpp</a>.</p>

</div>
</div>
<a id="a4c0a2d000e3994b7eeec3064112dcc5e" name="a4c0a2d000e3994b7eeec3064112dcc5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c0a2d000e3994b7eeec3064112dcc5e">&#9670;&nbsp;</a></span>Segments_in_shm</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Shm_arena &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html">ipc::transport::struc::shm::Reader</a>&lt; Shm_arena &gt;::Segments_in_shm =  typename <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Capnp__message__builder.html">Capnp_message_builder</a>&lt;<a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a42c8e0c8210121f3969aeb019df5c5b3">Arena</a>&gt;::Segments_in_shm_borrowed</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The data structure populated by <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html" title="Implements Struct_builder concept with maximal zero-copy perf by (1) storing the actual user-schema-c...">shm::Builder</a> counterpart. </p>
<p >Note, in particular, that this uses the same <code><a class="el" href="classAllocator.html">Allocator</a></code> type. <em>However</em> (as discussed as of this writing inside <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#aceb5816f4e9f312a8ce2ef17feb81223" title="Implements concept API.">deserialization()</a>) we use strictly a <code>const</code> <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a4c0a2d000e3994b7eeec3064112dcc5e" title="The data structure populated by shm::Builder counterpart.">Segments_in_shm</a> &ndash; read-only access only &ndash; and therefore never <em>use</em> the actual allocator <em>object</em>; only its <code>pointer</code> type. We never use the allocator to allocate or deallocate inner data of <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a4c0a2d000e3994b7eeec3064112dcc5e" title="The data structure populated by shm::Builder counterpart.">Segments_in_shm</a>.</p>
<p >I state for your informational convenience: As of this writing this is a <code>list&lt;Basic_blob&gt;</code>. <code>Basic_blob</code> is very similar to <code>Blob</code> used all over the code (just SHM-friendly); and thus it is a cooler version of <code>vector&lt;uint8_t&gt;</code>. </p>

<p class="definition">Definition at line <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00479">479</a> of file <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html">serializer.hpp</a>.</p>

</div>
</div>
<a id="ae77502abf0b04ad7543266fc6c34f49d" name="ae77502abf0b04ad7543266fc6c34f49d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae77502abf0b04ad7543266fc6c34f49d">&#9670;&nbsp;</a></span>Session</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Shm_arena &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html">ipc::transport::struc::shm::Reader</a>&lt; Shm_arena &gt;::Session =  typename <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html">Builder</a>&lt;Shm_arena&gt;::Session</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>See <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#a2d9808d9b0c04cf84c8e439b1643506d" title="Implements concept API.">shm::Builder::Session</a>. </p>

<p class="definition">Definition at line <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00376">376</a> of file <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html">serializer.hpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a42d9fb1ff01d3acfc5adf01f16abadba" name="a42d9fb1ff01d3acfc5adf01f16abadba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42d9fb1ff01d3acfc5adf01f16abadba">&#9670;&nbsp;</a></span>Reader()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Shm_arena &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html">ipc::transport::struc::shm::Reader</a>&lt; Shm_arena &gt;::Reader </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structipc_1_1transport_1_1struc_1_1shm_1_1Reader_1_1Config.html">Config</a> &amp;&#160;</td>
          <td class="paramname"><em>config</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implements concept API. </p>
<p >See <a class="el" href="structipc_1_1transport_1_1struc_1_1shm_1_1Reader_1_1Config.html" title="Implements Struct_reader::Config sub-concept.">Config</a> doc header for information on how <code>*this</code> behavior is controlled by <code>config</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">config</td><td>See above.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__reader.html#a4dc980273439330d6d2359e764c7680a" title="Default ctor, leaving *this in a state only suitable for destruction or being moved-to.">Struct_reader::Struct_reader()</a>: implemented concept. </dd></dl>

<p class="definition">Definition at line <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00651">651</a> of file <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html">serializer.hpp</a>.</p>

</div>
</div>
<a id="a37d334b7f819c2cf9b8d8ec07cb4ad09" name="a37d334b7f819c2cf9b8d8ec07cb4ad09"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37d334b7f819c2cf9b8d8ec07cb4ad09">&#9670;&nbsp;</a></span>~Reader()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Shm_arena &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html">ipc::transport::struc::shm::Reader</a>&lt; Shm_arena &gt;::~<a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html">Reader</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Implements concept API. </p>
<p >In this impl: acts essentially identically to <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html#af2d88517cf0d99186a6062279d6eb0d3" title="Implements concept API.">shm::Builder::~Builder()</a> dtor: decrements the owner-process ref-count by 1; if that made it go from 1 to 0 then the underlying SHM-allocated segments are deallocated (possibly asynchronously depending on the SHM provider's behavior); but if it went from 2 to 1 then not (<a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Builder.html" title="Implements Struct_builder concept with maximal zero-copy perf by (1) storing the actual user-schema-c...">shm::Builder</a> dtor is yet to run). If there are other <code><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html" title="Implements Struct_reader concept by interpreting a serialization by shm::Builder with the same templa...">Reader</a></code>s in the picture, the ref-count may have grown beyond 2.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__reader.html#a66ccf2eda9b6302a98b0f326292332d2" title="Destructor. Do not use the Reader deserialization() or any copies thereof past this.">Struct_reader::~Struct_reader()</a>: implemented concept. </dd></dl>

<p class="definition">Definition at line <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00665">665</a> of file <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html">serializer.hpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a2f57ff0e946af136ae3746d317008db5" name="a2f57ff0e946af136ae3746d317008db5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f57ff0e946af136ae3746d317008db5">&#9670;&nbsp;</a></span>add_serialization_segment()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Shm_arena &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">flow::util::Blob * <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html">ipc::transport::struc::shm::Reader</a>&lt; Shm_arena &gt;::add_serialization_segment </td>
          <td>(</td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>max_sz</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Implements concept API. </p>
<p >Reminder: you must <code>.resize()</code> the returned <code>Blob</code> in-place to indicate the size of the actual segment, before attempting <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#aceb5816f4e9f312a8ce2ef17feb81223" title="Implements concept API.">deserialization()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">max_sz</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>See above. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__reader.html#ae450aff09cc9d71b75b382d59a9cfc23" title="Prior to deserialization() obtains a memory area max_sz bytes long into which the user may write-to u...">Struct_reader::add_serialization_segment()</a>: implemented concept. </dd></dl>

<p class="definition">Definition at line <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00672">672</a> of file <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html">serializer.hpp</a>.</p>

</div>
</div>
<a id="aceb5816f4e9f312a8ce2ef17feb81223" name="aceb5816f4e9f312a8ce2ef17feb81223"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aceb5816f4e9f312a8ce2ef17feb81223">&#9670;&nbsp;</a></span>deserialization()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Shm_arena &gt; </div>
<div class="memtemplate">
template&lt;typename Struct &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">Struct::Reader <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html">ipc::transport::struc::shm::Reader</a>&lt; Shm_arena &gt;::deserialization </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> *&#160;</td>
          <td class="paramname"><em>err_code</em> = <code>0</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Implements concept API. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">Struct</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">err_code</td><td>See above. <a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89" title="Short-hand for flow::Error_code which is very common.">Error_code</a> generated: <a class="el" href="namespaceipc_1_1transport_1_1struc_1_1error.html#a990b9ff850cf9aaf354efdd07d86a71da0051bcafea044bc07af9f4aca02f0e3b" title="Structured message deserialization: Tried to deserialize without enough input segments (e....">struc::error::Code::S_DESERIALIZE_FAILED_INSUFFICIENT_SEGMENTS</a> (<a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a2f57ff0e946af136ae3746d317008db5" title="Implements concept API.">add_serialization_segment()</a> never called; or somehow opposing builder serialized an empty segment list &ndash; this would be a bug on their part), <a class="el" href="namespaceipc_1_1transport_1_1struc_1_1error.html#a990b9ff850cf9aaf354efdd07d86a71dae309ae915136b629fafaec158040a406" title="Structured message deserialization: An input segment is not aligned as required.">struc::error::Code::S_DESERIALIZE_FAILED_SEGMENT_MISALIGNED</a> (<a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a2f57ff0e946af136ae3746d317008db5" title="Implements concept API.">add_serialization_segment()</a>-returned segment was modified subsequently to start at a misaligned address; or somehow the opposing builder supplied a segment that starts at a misaligned address &ndash; this would be a bug on their part), <a class="el" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1error.html#a25a6db383af491442917e2dc8ff944a8a193ecb77fe093a4d59f5fafe68389624" title="Structured message deserialization: SHM-session borrow_object() indicated failure when interpreting a...">error::Code::S_DESERIALIZE_FAILED_SESSION_HOSED</a> (the SHM-session was unable to determine the location of the serialization in SHM, because its <code>borrow_object()</code> method indicated the session is down, or the information transmitted over IPC was in some way invalid). </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>See above.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classipc_1_1transport_1_1struc_1_1Struct__reader.html#a95576f8cd8ad45a720276bd074cea4f2" title="After all serialization segments have been acquired in RAM via add_serialization_segment() and finali...">Struct_reader::deserialization()</a>: implemented concept. </dd></dl>

<p class="definition">Definition at line <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00681">681</a> of file <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html">serializer.hpp</a>.</p>

<p class="reference">References <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2util_8cpp_source.html#l00051">ipc::transport::struc::shm::capnp_get_shm_handle_to_borrow()</a>, <a class="el" href="namespaceipc_1_1transport_1_1struc_1_1error.html#a990b9ff850cf9aaf354efdd07d86a71da0051bcafea044bc07af9f4aca02f0e3b">ipc::transport::struc::error::S_DESERIALIZE_FAILED_INSUFFICIENT_SEGMENTS</a>, <a class="el" href="namespaceipc_1_1transport_1_1struc_1_1error.html#a990b9ff850cf9aaf354efdd07d86a71dae309ae915136b629fafaec158040a406">ipc::transport::struc::error::S_DESERIALIZE_FAILED_SEGMENT_MISALIGNED</a>, and <a class="el" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1error.html#a25a6db383af491442917e2dc8ff944a8a193ecb77fe093a4d59f5fafe68389624">ipc::transport::struc::shm::error::S_DESERIALIZE_FAILED_SESSION_HOSED</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classipc_1_1transport_1_1struc_1_1shm_1_1Reader_aceb5816f4e9f312a8ce2ef17feb81223_cgraph.svg" width="395" height="59"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>

</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a6aed71b2ab83f2a087d66562ea2962b9" name="a6aed71b2ab83f2a087d66562ea2962b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6aed71b2ab83f2a087d66562ea2962b9">&#9670;&nbsp;</a></span>operator&lt;&lt;()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Shm_arena &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::ostream &amp; operator&lt;&lt; </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>os</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html">Reader</a>&lt; Shm_arena &gt; &amp;&#160;</td>
          <td class="paramname"><em>val</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Prints string representation of the given <code><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html" title="Implements Struct_reader concept by interpreting a serialization by shm::Builder with the same templa...">Reader</a></code> to the given <code>ostream</code>. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">os</td><td>Stream to which to write. </td></tr>
    <tr><td class="paramname">val</td><td>Object to serialize. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>os</code>. </dd></dl>

<p class="definition">Definition at line <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00860">860</a> of file <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html">serializer.hpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a36e431a3536848c99dd4f55a4d6b1453" name="a36e431a3536848c99dd4f55a4d6b1453"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36e431a3536848c99dd4f55a4d6b1453">&#9670;&nbsp;</a></span>m_btm_capnp_segments</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Shm_arena &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::vector&lt;<a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a67e07b2f8cdaff62e3f7223f4440826e">Capnp_word_array_ptr</a>&gt; <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html">ipc::transport::struc::shm::Reader</a>&lt; Shm_arena &gt;::m_btm_capnp_segments</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Analogous to <a class="el" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html#ae514982795db7d0301a7929d1006d30b" title="After deserialization(), capnp-targeted data structure which is essentially vector&lt;&gt; of each Blob::co...">Heap_reader::m_capnp_segments</a>; just points into SHM. </p>

<p class="definition">Definition at line <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00502">502</a> of file <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html">serializer.hpp</a>.</p>

</div>
</div>
<a id="aea972cb0e04d447941d2080c2f2d3a98" name="aea972cb0e04d447941d2080c2f2d3a98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea972cb0e04d447941d2080c2f2d3a98">&#9670;&nbsp;</a></span>m_btm_engine</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Shm_arena &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#ae4b859bec8f09d37cb041a8ee40c5007">Capnp_heap_engine_ptr</a> <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html">ipc::transport::struc::shm::Reader</a>&lt; Shm_arena &gt;::m_btm_engine</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>See <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a4bf6b31e4a5896d7ecc3236f1498602d" title="Same as in Heap_reader but this time applied to SHM-stored segments in m_btm_serialization_shm_handle...">Capnp_heap_engine</a>. </p>

<p class="definition">Definition at line <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00493">493</a> of file <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html">serializer.hpp</a>.</p>

</div>
</div>
<a id="a57144d8e687161731d662b7d7b23fd0e" name="a57144d8e687161731d662b7d7b23fd0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57144d8e687161731d662b7d7b23fd0e">&#9670;&nbsp;</a></span>m_btm_serialization_shm_handle</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Shm_arena &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Arena::template Handle&lt;<a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a4c0a2d000e3994b7eeec3064112dcc5e">Segments_in_shm</a>&gt; <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html">ipc::transport::struc::shm::Reader</a>&lt; Shm_arena &gt;::m_btm_serialization_shm_handle</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The outer SHM handle to the <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#a4c0a2d000e3994b7eeec3064112dcc5e" title="The data structure populated by shm::Builder counterpart.">Segments_in_shm</a> containing the serialization yielded by payload_msg_builder(). </p>
<p >It is null until <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#aceb5816f4e9f312a8ce2ef17feb81223" title="Implements concept API.">deserialization()</a> where it's assigned from <code>m_session-&gt;borrow_object&lt;T&gt;()</code>. </p>

<p class="definition">Definition at line <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00499">499</a> of file <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html">serializer.hpp</a>.</p>

</div>
</div>
<a id="af9f19bfd2d275b3770a3c978ae451c31" name="af9f19bfd2d275b3770a3c978ae451c31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9f19bfd2d275b3770a3c978ae451c31">&#9670;&nbsp;</a></span>m_session</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Shm_arena &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html#ae77502abf0b04ad7543266fc6c34f49d">Session</a> <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html">ipc::transport::struc::shm::Reader</a>&lt; Shm_arena &gt;::m_session</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>See class doc header and ctor doc header. </p>

<p class="definition">Definition at line <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00487">487</a> of file <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html">serializer.hpp</a>.</p>

</div>
</div>
<a id="a1edc9404d82d1fe78fd4a892d5dac22c" name="a1edc9404d82d1fe78fd4a892d5dac22c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1edc9404d82d1fe78fd4a892d5dac22c">&#9670;&nbsp;</a></span>m_top_engine</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Shm_arena &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html">Heap_reader</a> <a class="el" href="classipc_1_1transport_1_1struc_1_1shm_1_1Reader.html">ipc::transport::struc::shm::Reader</a>&lt; Shm_arena &gt;::m_top_engine</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The top-serialization reader, namely <a class="el" href="classipc_1_1transport_1_1struc_1_1Heap__reader.html" title="Implements Struct_reader concept by straightforwardly interpreting a serialization by Heap_fixed_buil...">Heap_reader</a>, of our simple SHM-handle-bearing schema. </p>

<p class="definition">Definition at line <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html#l00490">490</a> of file <a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html">serializer.hpp</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>transport/struc/shm/<a class="el" href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2serializer_8hpp_source.html">serializer.hpp</a></li>
<li>transport/struc/shm/<a class="el" href="transport_2struc_2shm_2shm__fwd_8hpp_source.html">shm_fwd.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:27 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
